feat: add README template generator with Node.js workflow and configuration examples #155
Conversation
for more information, see https://pre-commit.ci
There was a problem hiding this comment.
Not sure what these were... should they be part of the repo?
There was a problem hiding this comment.
Not sure what these were... should they be part of the repo?
There was a problem hiding this comment.
Not sure what these were... should they be part of the repo?
There was a problem hiding this comment.
Not sure what these were... should they be part of the repo?
There was a problem hiding this comment.
Not sure what these were... should they be part of the repo?
There was a problem hiding this comment.
New for this PR - auto generates the readme everytime there is an update to the config.json or the template file.
There was a problem hiding this comment.
Updated to have handlebars for the config.json file for auto readme generation
There was a problem hiding this comment.
Most of these changes were captured in Markdown Linting #152
That said, if you approve that PR, these changes should be reduced and you will see the net impact of using the generating file.
There was a problem hiding this comment.
Parameter file used for the automatic generation of Readme.md
There was a problem hiding this comment.
You were missing a .gitignore and I ran some tests etc. with code tools locally, so I made one to just make it simple to not need to clean the directory tree all the time
1 participant
🎯 Overview
This PR migrates the README template generation system to use a dedicated readme generator tool maintained in a separate repository, and integrates it into this project via pre-commit hooks. This enables automated, consistent, and professional README generation as part of the development workflow.
Note: This builds on #152 and #153. If you see additional file changes, it's because those PRs have not yet been merged.
✨ Features & Improvements
🛠️ Pre-commit Integration
pre-commit-readme-generatortool.📋 Template & Config Enhancements
configs/example.json) for flexible project documentation.BLANK_README.md) supporting dynamic sections, badges, roadmap, and contact info.🧩 Workflow & Developer Experience
.pre-commit-config.yamlto get new features or fixes.🔄 Usage
📁 Files Added/Modified
Added
.pre-commit-config.yaml— Adds hook for external generator tool.configs/example.json— Full-featured example configuration.configs/minimal.json— Minimal configuration template.Modified
BLANK_README.md— Enhanced Handlebars template for dynamic README generation..gitignore— Ensures node_modules, venv, and generated files are ignored.Removed
✅ Testing
🚀 Impact
This PR modernizes and automates README management, ensuring every commit maintains high-quality, consistent documentation with minimal developer effort.
🔗Related Issues
Closes #154